home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2003 August / MW 8 2003 CD1.iso / Inside Macworld / Product News / gimp-1.2.4.sit / gimp-1.2.4 / devel-docs / libgimp / sgml / gimpdrawable.sgml < prev    next >
Encoding:
Text File  |  2003-05-20  |  34.8 KB  |  795 lines
  1. <refentry id="libgimp-gimpdrawable" revision="19 Jan 2001">
  2. <refmeta>
  3. <refentrytitle>gimpdrawable</refentrytitle>
  4. <manvolnum>3</manvolnum>
  5. <refmiscinfo>LIBGIMP Library</refmiscinfo>
  6. </refmeta>
  7.  
  8. <refnamediv>
  9. <refname>gimpdrawable</refname><refpurpose></refpurpose>
  10. </refnamediv>
  11.  
  12. <refsynopsisdiv><title>Synopsis</title>
  13. <synopsis>
  14.  
  15.  
  16.  
  17. struct      <link linkend="GimpDrawable">GimpDrawable</link>;
  18. <link linkend="GimpDrawable">GimpDrawable</link>* <link linkend="gimp-drawable-get">gimp_drawable_get</link>             (<link linkend="gint32">gint32</link> drawable_ID);
  19. void        <link linkend="gimp-drawable-detach">gimp_drawable_detach</link>            (<link linkend="GimpDrawable">GimpDrawable</link> *drawable);
  20. void        <link linkend="gimp-drawable-flush">gimp_drawable_flush</link>             (<link linkend="GimpDrawable">GimpDrawable</link> *drawable);
  21. void        <link linkend="gimp-drawable-delete">gimp_drawable_delete</link>            (<link linkend="GimpDrawable">GimpDrawable</link> *drawable);
  22. <link linkend="gchar">gchar</link>*      <link linkend="gimp-drawable-name">gimp_drawable_name</link>              (<link linkend="gint32">gint32</link> drawable_ID);
  23. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-drawable-visible">gimp_drawable_visible</link>           (<link linkend="gint32">gint32</link> drawable_ID);
  24. void        <link linkend="gimp-drawable-set-name">gimp_drawable_set_name</link>          (<link linkend="gint32">gint32</link> drawable_ID,
  25.                                              <link linkend="gchar">gchar</link> *name);
  26. void        <link linkend="gimp-drawable-set-visible">gimp_drawable_set_visible</link>       (<link linkend="gint32">gint32</link> drawable_ID,
  27.                                              <link linkend="gboolean">gboolean</link> visible);
  28. <link linkend="GimpTile">GimpTile</link>*   <link linkend="gimp-drawable-get-tile">gimp_drawable_get_tile</link>          (<link linkend="GimpDrawable">GimpDrawable</link> *drawable,
  29.                                              <link linkend="gint">gint</link> shadow,
  30.                                              <link linkend="gint">gint</link> row,
  31.                                              <link linkend="gint">gint</link> col);
  32. <link linkend="GimpTile">GimpTile</link>*   <link linkend="gimp-drawable-get-tile2">gimp_drawable_get_tile2</link>         (<link linkend="GimpDrawable">GimpDrawable</link> *drawable,
  33.                                              <link linkend="gint">gint</link> shadow,
  34.                                              <link linkend="gint">gint</link> x,
  35.                                              <link linkend="gint">gint</link> y);
  36. <link linkend="guchar">guchar</link>*     <link linkend="gimp-drawable-get-thumbnail-data">gimp_drawable_get_thumbnail_data</link>
  37.                                             (<link linkend="gint32">gint32</link> drawable_ID,
  38.                                              <link linkend="gint">gint</link> *width,
  39.                                              <link linkend="gint">gint</link> *height,
  40.                                              <link linkend="gint">gint</link> *bpp);
  41. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-drawable-merge-shadow">gimp_drawable_merge_shadow</link>      (<link linkend="gint32">gint32</link> drawable_ID,
  42.                                              <link linkend="gboolean">gboolean</link> undo);
  43. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-drawable-fill">gimp_drawable_fill</link>              (<link linkend="gint32">gint32</link> drawable_ID,
  44.                                              <link linkend="GimpFillType">GimpFillType</link> fill_type);
  45. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-drawable-update">gimp_drawable_update</link>            (<link linkend="gint32">gint32</link> drawable_ID,
  46.                                              <link linkend="gint">gint</link> x,
  47.                                              <link linkend="gint">gint</link> y,
  48.                                              <link linkend="gint">gint</link> width,
  49.                                              <link linkend="gint">gint</link> height);
  50. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-drawable-mask-bounds">gimp_drawable_mask_bounds</link>       (<link linkend="gint32">gint32</link> drawable_ID,
  51.                                              <link linkend="gint">gint</link> *x1,
  52.                                              <link linkend="gint">gint</link> *y1,
  53.                                              <link linkend="gint">gint</link> *x2,
  54.                                              <link linkend="gint">gint</link> *y2);
  55. <link linkend="gint32">gint32</link>      <link linkend="gimp-drawable-image">gimp_drawable_image</link>             (<link linkend="gint32">gint32</link> drawable_ID);
  56. <link linkend="GimpImageType">GimpImageType</link> <link linkend="gimp-drawable-type">gimp_drawable_type</link>            (<link linkend="gint32">gint32</link> drawable_ID);
  57. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-drawable-has-alpha">gimp_drawable_has_alpha</link>         (<link linkend="gint32">gint32</link> drawable_ID);
  58. <link linkend="GimpImageType">GimpImageType</link> <link linkend="gimp-drawable-type-with-alpha">gimp_drawable_type_with_alpha</link> (<link linkend="gint32">gint32</link> drawable_ID);
  59. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-drawable-is-rgb">gimp_drawable_is_rgb</link>            (<link linkend="gint32">gint32</link> drawable_ID);
  60. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-drawable-is-gray">gimp_drawable_is_gray</link>           (<link linkend="gint32">gint32</link> drawable_ID);
  61. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-drawable-is-indexed">gimp_drawable_is_indexed</link>        (<link linkend="gint32">gint32</link> drawable_ID);
  62. <link linkend="gint">gint</link>        <link linkend="gimp-drawable-bytes">gimp_drawable_bytes</link>             (<link linkend="gint32">gint32</link> drawable_ID);
  63. <link linkend="gint">gint</link>        <link linkend="gimp-drawable-width">gimp_drawable_width</link>             (<link linkend="gint32">gint32</link> drawable_ID);
  64. <link linkend="gint">gint</link>        <link linkend="gimp-drawable-height">gimp_drawable_height</link>            (<link linkend="gint32">gint32</link> drawable_ID);
  65. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-drawable-offsets">gimp_drawable_offsets</link>           (<link linkend="gint32">gint32</link> drawable_ID,
  66.                                              <link linkend="gint">gint</link> *offset_x,
  67.                                              <link linkend="gint">gint</link> *offset_y);
  68. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-drawable-is-layer">gimp_drawable_is_layer</link>          (<link linkend="gint32">gint32</link> drawable_ID);
  69. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-drawable-is-layer-mask">gimp_drawable_is_layer_mask</link>     (<link linkend="gint32">gint32</link> drawable_ID);
  70. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-drawable-is-channel">gimp_drawable_is_channel</link>        (<link linkend="gint32">gint32</link> drawable_ID);
  71. #define     <link linkend="gimp-drawable-offset">gimp_drawable_offset</link>
  72. #define     <link linkend="gimp-drawable-image-id">gimp_drawable_image_id</link>
  73. #define     <link linkend="gimp-drawable-bpp">gimp_drawable_bpp</link>
  74. </synopsis>
  75. </refsynopsisdiv>
  76.  
  77.  
  78.  
  79.  
  80.  
  81. <refsect1>
  82. <title>Description</title>
  83. <para>
  84.  
  85. </para>
  86. </refsect1>
  87.  
  88. <refsect1>
  89. <title>Details</title>
  90. <refsect2>
  91. <title><anchor id="GimpDrawable">struct GimpDrawable</title>
  92. <programlisting>struct GimpDrawable
  93. {
  94.   gint32    id;            /* drawable ID */
  95.   guint     width;         /* width of drawble */
  96.   guint     height;        /* height of drawble */
  97.   guint     bpp;           /* bytes per pixel of drawable */
  98.   guint     ntile_rows;    /* # of tile rows */
  99.   guint     ntile_cols;    /* # of tile columns */
  100.   GimpTile *tiles;         /* the normal tiles */
  101.   GimpTile *shadow_tiles;  /* the shadow tiles */
  102. };
  103. </programlisting>
  104. <para>
  105.  
  106. </para></refsect2>
  107. <refsect2>
  108. <title><anchor id="gimp-drawable-get">gimp_drawable_get ()</title>
  109. <programlisting><link linkend="GimpDrawable">GimpDrawable</link>* gimp_drawable_get             (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  110. <para>
  111.  
  112. </para><informaltable pgwide=1 frame="none" role="params">
  113. <tgroup cols="2">
  114. <colspec colwidth="2*">
  115. <colspec colwidth="8*">
  116. <tbody>
  117. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  118. <entry></entry></row>
  119. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>
  120.  
  121. </entry></row>
  122. </tbody></tgroup></informaltable></refsect2>
  123. <refsect2>
  124. <title><anchor id="gimp-drawable-detach">gimp_drawable_detach ()</title>
  125. <programlisting>void        gimp_drawable_detach            (<link linkend="GimpDrawable">GimpDrawable</link> *drawable);</programlisting>
  126. <para>
  127.  
  128. </para><informaltable pgwide=1 frame="none" role="params">
  129. <tgroup cols="2">
  130. <colspec colwidth="2*">
  131. <colspec colwidth="8*">
  132. <tbody>
  133. <row><entry align="right"><parameter>drawable</parameter> :</entry>
  134. <entry>
  135.  
  136. </entry></row>
  137. </tbody></tgroup></informaltable></refsect2>
  138. <refsect2>
  139. <title><anchor id="gimp-drawable-flush">gimp_drawable_flush ()</title>
  140. <programlisting>void        gimp_drawable_flush             (<link linkend="GimpDrawable">GimpDrawable</link> *drawable);</programlisting>
  141. <para>
  142.  
  143. </para><informaltable pgwide=1 frame="none" role="params">
  144. <tgroup cols="2">
  145. <colspec colwidth="2*">
  146. <colspec colwidth="8*">
  147. <tbody>
  148. <row><entry align="right"><parameter>drawable</parameter> :</entry>
  149. <entry>
  150.  
  151. </entry></row>
  152. </tbody></tgroup></informaltable></refsect2>
  153. <refsect2>
  154. <title><anchor id="gimp-drawable-delete">gimp_drawable_delete ()</title>
  155. <programlisting>void        gimp_drawable_delete            (<link linkend="GimpDrawable">GimpDrawable</link> *drawable);</programlisting>
  156. <para>
  157.  
  158. </para><informaltable pgwide=1 frame="none" role="params">
  159. <tgroup cols="2">
  160. <colspec colwidth="2*">
  161. <colspec colwidth="8*">
  162. <tbody>
  163. <row><entry align="right"><parameter>drawable</parameter> :</entry>
  164. <entry>
  165.  
  166. </entry></row>
  167. </tbody></tgroup></informaltable></refsect2>
  168. <refsect2>
  169. <title><anchor id="gimp-drawable-name">gimp_drawable_name ()</title>
  170. <programlisting><link linkend="gchar">gchar</link>*      gimp_drawable_name              (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  171. <para>
  172.  
  173. </para><informaltable pgwide=1 frame="none" role="params">
  174. <tgroup cols="2">
  175. <colspec colwidth="2*">
  176. <colspec colwidth="8*">
  177. <tbody>
  178. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  179. <entry></entry></row>
  180. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>
  181.  
  182. </entry></row>
  183. </tbody></tgroup></informaltable></refsect2>
  184. <refsect2>
  185. <title><anchor id="gimp-drawable-visible">gimp_drawable_visible ()</title>
  186. <programlisting><link linkend="gboolean">gboolean</link>    gimp_drawable_visible           (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  187. <para>
  188.  
  189. </para><informaltable pgwide=1 frame="none" role="params">
  190. <tgroup cols="2">
  191. <colspec colwidth="2*">
  192. <colspec colwidth="8*">
  193. <tbody>
  194. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  195. <entry></entry></row>
  196. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>
  197.  
  198. </entry></row>
  199. </tbody></tgroup></informaltable></refsect2>
  200. <refsect2>
  201. <title><anchor id="gimp-drawable-set-name">gimp_drawable_set_name ()</title>
  202. <programlisting>void        gimp_drawable_set_name          (<link linkend="gint32">gint32</link> drawable_ID,
  203.                                              <link linkend="gchar">gchar</link> *name);</programlisting>
  204. <para>
  205.  
  206. </para><informaltable pgwide=1 frame="none" role="params">
  207. <tgroup cols="2">
  208. <colspec colwidth="2*">
  209. <colspec colwidth="8*">
  210. <tbody>
  211. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  212. <entry></entry></row>
  213. <row><entry align="right"><parameter>name</parameter> :</entry>
  214. <entry>
  215.  
  216. </entry></row>
  217. </tbody></tgroup></informaltable></refsect2>
  218. <refsect2>
  219. <title><anchor id="gimp-drawable-set-visible">gimp_drawable_set_visible ()</title>
  220. <programlisting>void        gimp_drawable_set_visible       (<link linkend="gint32">gint32</link> drawable_ID,
  221.                                              <link linkend="gboolean">gboolean</link> visible);</programlisting>
  222. <para>
  223.  
  224. </para><informaltable pgwide=1 frame="none" role="params">
  225. <tgroup cols="2">
  226. <colspec colwidth="2*">
  227. <colspec colwidth="8*">
  228. <tbody>
  229. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  230. <entry></entry></row>
  231. <row><entry align="right"><parameter>visible</parameter> :</entry>
  232. <entry>
  233.  
  234. </entry></row>
  235. </tbody></tgroup></informaltable></refsect2>
  236. <refsect2>
  237. <title><anchor id="gimp-drawable-get-tile">gimp_drawable_get_tile ()</title>
  238. <programlisting><link linkend="GimpTile">GimpTile</link>*   gimp_drawable_get_tile          (<link linkend="GimpDrawable">GimpDrawable</link> *drawable,
  239.                                              <link linkend="gint">gint</link> shadow,
  240.                                              <link linkend="gint">gint</link> row,
  241.                                              <link linkend="gint">gint</link> col);</programlisting>
  242. <para>
  243.  
  244. </para><informaltable pgwide=1 frame="none" role="params">
  245. <tgroup cols="2">
  246. <colspec colwidth="2*">
  247. <colspec colwidth="8*">
  248. <tbody>
  249. <row><entry align="right"><parameter>drawable</parameter> :</entry>
  250. <entry></entry></row>
  251. <row><entry align="right"><parameter>shadow</parameter> :</entry>
  252. <entry></entry></row>
  253. <row><entry align="right"><parameter>row</parameter> :</entry>
  254. <entry></entry></row>
  255. <row><entry align="right"><parameter>col</parameter> :</entry>
  256. <entry></entry></row>
  257. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>
  258.  
  259. </entry></row>
  260. </tbody></tgroup></informaltable></refsect2>
  261. <refsect2>
  262. <title><anchor id="gimp-drawable-get-tile2">gimp_drawable_get_tile2 ()</title>
  263. <programlisting><link linkend="GimpTile">GimpTile</link>*   gimp_drawable_get_tile2         (<link linkend="GimpDrawable">GimpDrawable</link> *drawable,
  264.                                              <link linkend="gint">gint</link> shadow,
  265.                                              <link linkend="gint">gint</link> x,
  266.                                              <link linkend="gint">gint</link> y);</programlisting>
  267. <para>
  268.  
  269. </para><informaltable pgwide=1 frame="none" role="params">
  270. <tgroup cols="2">
  271. <colspec colwidth="2*">
  272. <colspec colwidth="8*">
  273. <tbody>
  274. <row><entry align="right"><parameter>drawable</parameter> :</entry>
  275. <entry></entry></row>
  276. <row><entry align="right"><parameter>shadow</parameter> :</entry>
  277. <entry></entry></row>
  278. <row><entry align="right"><parameter>x</parameter> :</entry>
  279. <entry></entry></row>
  280. <row><entry align="right"><parameter>y</parameter> :</entry>
  281. <entry></entry></row>
  282. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>
  283.  
  284. </entry></row>
  285. </tbody></tgroup></informaltable></refsect2>
  286. <refsect2>
  287. <title><anchor id="gimp-drawable-get-thumbnail-data">gimp_drawable_get_thumbnail_data ()</title>
  288. <programlisting><link linkend="guchar">guchar</link>*     gimp_drawable_get_thumbnail_data
  289.                                             (<link linkend="gint32">gint32</link> drawable_ID,
  290.                                              <link linkend="gint">gint</link> *width,
  291.                                              <link linkend="gint">gint</link> *height,
  292.                                              <link linkend="gint">gint</link> *bpp);</programlisting>
  293. <para>
  294.  
  295. </para><informaltable pgwide=1 frame="none" role="params">
  296. <tgroup cols="2">
  297. <colspec colwidth="2*">
  298. <colspec colwidth="8*">
  299. <tbody>
  300. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  301. <entry></entry></row>
  302. <row><entry align="right"><parameter>width</parameter> :</entry>
  303. <entry></entry></row>
  304. <row><entry align="right"><parameter>height</parameter> :</entry>
  305. <entry></entry></row>
  306. <row><entry align="right"><parameter>bpp</parameter> :</entry>
  307. <entry></entry></row>
  308. </tbody></tgroup></informaltable></refsect2>
  309. <refsect2>
  310. <title><anchor id="gimp-drawable-merge-shadow">gimp_drawable_merge_shadow ()</title>
  311. <programlisting><link linkend="gboolean">gboolean</link>    gimp_drawable_merge_shadow      (<link linkend="gint32">gint32</link> drawable_ID,
  312.                                              <link linkend="gboolean">gboolean</link> undo);</programlisting>
  313. <para>
  314. Merge the shadow buffer with the specified drawable.
  315. </para>
  316. <para>
  317. This procedure combines the contents of the image's shadow buffer
  318. (for temporary processing) with the specified drawable. The \"undo\"
  319. parameter specifies whether to add an undo step for the operation.
  320. Requesting no undo is useful for such applications as 'auto-apply'.</para>
  321. <para>
  322.  
  323. </para><informaltable pgwide=1 frame="none" role="params">
  324. <tgroup cols="2">
  325. <colspec colwidth="2*">
  326. <colspec colwidth="8*">
  327. <tbody>
  328. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  329. <entry> The drawable.
  330. </entry></row>
  331. <row><entry align="right"><parameter>undo</parameter> :</entry>
  332. <entry> Push merge to undo stack?
  333. </entry></row>
  334. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  335. </entry></row>
  336. </tbody></tgroup></informaltable></refsect2>
  337. <refsect2>
  338. <title><anchor id="gimp-drawable-fill">gimp_drawable_fill ()</title>
  339. <programlisting><link linkend="gboolean">gboolean</link>    gimp_drawable_fill              (<link linkend="gint32">gint32</link> drawable_ID,
  340.                                              <link linkend="GimpFillType">GimpFillType</link> fill_type);</programlisting>
  341. <para>
  342. Fill the drawable with the specified fill mode.
  343. </para>
  344. <para>
  345. This procedure fills the drawable with the fill mode. If the fill
  346. mode is foreground the current foreground color is used. If the fill
  347. mode is background, the current background color is used. If the
  348. fill type is white, then white is used. Transparent fill only
  349. affects layers with an alpha channel, in which case the alpha
  350. channel is set to transparent. If the drawable has no alpha channel,
  351. it is filled to white. No fill leaves the drawable's contents
  352. undefined. This procedure is unlike the bucket fill tool because it
  353. fills regardless of a selection</para>
  354. <para>
  355.  
  356. </para><informaltable pgwide=1 frame="none" role="params">
  357. <tgroup cols="2">
  358. <colspec colwidth="2*">
  359. <colspec colwidth="8*">
  360. <tbody>
  361. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  362. <entry> The drawable.
  363. </entry></row>
  364. <row><entry align="right"><parameter>fill_type</parameter> :</entry>
  365. <entry> The type of fill.
  366. </entry></row>
  367. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  368. </entry></row>
  369. </tbody></tgroup></informaltable></refsect2>
  370. <refsect2>
  371. <title><anchor id="gimp-drawable-update">gimp_drawable_update ()</title>
  372. <programlisting><link linkend="gboolean">gboolean</link>    gimp_drawable_update            (<link linkend="gint32">gint32</link> drawable_ID,
  373.                                              <link linkend="gint">gint</link> x,
  374.                                              <link linkend="gint">gint</link> y,
  375.                                              <link linkend="gint">gint</link> width,
  376.                                              <link linkend="gint">gint</link> height);</programlisting>
  377. <para>
  378. Update the specified region of the drawable.
  379. </para>
  380. <para>
  381. This procedure updates the specified region of the drawable. The (x,
  382. y) coordinate pair is relative to the drawable's origin, not to the
  383. image origin. Therefore, the entire drawable can be updated with:
  384. {x->0, y->0, w->width, h->height }.</para>
  385. <para>
  386.  
  387. </para><informaltable pgwide=1 frame="none" role="params">
  388. <tgroup cols="2">
  389. <colspec colwidth="2*">
  390. <colspec colwidth="8*">
  391. <tbody>
  392. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  393. <entry> The drawable.
  394. </entry></row>
  395. <row><entry align="right"><parameter>x</parameter> :</entry>
  396. <entry> x coordinate of upper left corner of update region.
  397. </entry></row>
  398. <row><entry align="right"><parameter>y</parameter> :</entry>
  399. <entry> y coordinate of upper left corner of update region.
  400. </entry></row>
  401. <row><entry align="right"><parameter>width</parameter> :</entry>
  402. <entry> Width of update region.
  403. </entry></row>
  404. <row><entry align="right"><parameter>height</parameter> :</entry>
  405. <entry> Height of update region.
  406. </entry></row>
  407. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  408. </entry></row>
  409. </tbody></tgroup></informaltable></refsect2>
  410. <refsect2>
  411. <title><anchor id="gimp-drawable-mask-bounds">gimp_drawable_mask_bounds ()</title>
  412. <programlisting><link linkend="gboolean">gboolean</link>    gimp_drawable_mask_bounds       (<link linkend="gint32">gint32</link> drawable_ID,
  413.                                              <link linkend="gint">gint</link> *x1,
  414.                                              <link linkend="gint">gint</link> *y1,
  415.                                              <link linkend="gint">gint</link> *x2,
  416.                                              <link linkend="gint">gint</link> *y2);</programlisting>
  417. <para>
  418. Find the bounding box of the current selection in relation to the
  419. specified drawable.
  420. </para>
  421. <para>
  422. This procedure returns the whether there is a selection. If there is
  423. one, the upper left and lower righthand corners of its bounding box
  424. are returned. These coordinates are specified relative to the
  425. drawable's origin, and bounded by the drawable's extents.</para>
  426. <para>
  427.  
  428. </para><informaltable pgwide=1 frame="none" role="params">
  429. <tgroup cols="2">
  430. <colspec colwidth="2*">
  431. <colspec colwidth="8*">
  432. <tbody>
  433. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  434. <entry> The drawable.
  435. </entry></row>
  436. <row><entry align="right"><parameter>x1</parameter> :</entry>
  437. <entry> x coordinate of the upper left corner of selection bounds.
  438. </entry></row>
  439. <row><entry align="right"><parameter>y1</parameter> :</entry>
  440. <entry> y coordinate of the upper left corner of selection bounds.
  441. </entry></row>
  442. <row><entry align="right"><parameter>x2</parameter> :</entry>
  443. <entry> x coordinate of the lower right corner of selection bounds.
  444. </entry></row>
  445. <row><entry align="right"><parameter>y2</parameter> :</entry>
  446. <entry> y coordinate of the lower right corner of selection bounds.
  447. </entry></row>
  448. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE if there is a selection.
  449. </entry></row>
  450. </tbody></tgroup></informaltable></refsect2>
  451. <refsect2>
  452. <title><anchor id="gimp-drawable-image">gimp_drawable_image ()</title>
  453. <programlisting><link linkend="gint32">gint32</link>      gimp_drawable_image             (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  454. <para>
  455. Returns the drawable's image.
  456. </para>
  457. <para>
  458. This procedure returns the drawable's image.</para>
  459. <para>
  460.  
  461. </para><informaltable pgwide=1 frame="none" role="params">
  462. <tgroup cols="2">
  463. <colspec colwidth="2*">
  464. <colspec colwidth="8*">
  465. <tbody>
  466. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  467. <entry> The drawable.
  468. </entry></row>
  469. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The drawable's image.
  470. </entry></row>
  471. </tbody></tgroup></informaltable></refsect2>
  472. <refsect2>
  473. <title><anchor id="gimp-drawable-type">gimp_drawable_type ()</title>
  474. <programlisting><link linkend="GimpImageType">GimpImageType</link> gimp_drawable_type            (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  475. <para>
  476. Returns the drawable's type.
  477. </para>
  478. <para>
  479. This procedure returns the drawable's type.</para>
  480. <para>
  481.  
  482. </para><informaltable pgwide=1 frame="none" role="params">
  483. <tgroup cols="2">
  484. <colspec colwidth="2*">
  485. <colspec colwidth="8*">
  486. <tbody>
  487. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  488. <entry> The drawable.
  489. </entry></row>
  490. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The drawable's type.
  491. </entry></row>
  492. </tbody></tgroup></informaltable></refsect2>
  493. <refsect2>
  494. <title><anchor id="gimp-drawable-has-alpha">gimp_drawable_has_alpha ()</title>
  495. <programlisting><link linkend="gboolean">gboolean</link>    gimp_drawable_has_alpha         (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  496. <para>
  497. Returns non-zero if the drawable has an alpha channel.
  498. </para>
  499. <para>
  500. This procedure returns whether the specified drawable has an alpha
  501. channel. This can only be true for layers, and the associated type
  502. will be one of: { RGBA , GRAYA, INDEXEDA }.</para>
  503. <para>
  504.  
  505. </para><informaltable pgwide=1 frame="none" role="params">
  506. <tgroup cols="2">
  507. <colspec colwidth="2*">
  508. <colspec colwidth="8*">
  509. <tbody>
  510. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  511. <entry> The drawable.
  512. </entry></row>
  513. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> Does the drawable have an alpha channel?
  514. </entry></row>
  515. </tbody></tgroup></informaltable></refsect2>
  516. <refsect2>
  517. <title><anchor id="gimp-drawable-type-with-alpha">gimp_drawable_type_with_alpha ()</title>
  518. <programlisting><link linkend="GimpImageType">GimpImageType</link> gimp_drawable_type_with_alpha (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  519. <para>
  520. Returns the drawable's type with alpha.
  521. </para>
  522. <para>
  523. This procedure returns the drawable's type if an alpha channel were
  524. added. If the type is currently Gray, for instance, the returned
  525. type would be GrayA. If the drawable already has an alpha channel,
  526. the drawable's type is simply returned.</para>
  527. <para>
  528.  
  529. </para><informaltable pgwide=1 frame="none" role="params">
  530. <tgroup cols="2">
  531. <colspec colwidth="2*">
  532. <colspec colwidth="8*">
  533. <tbody>
  534. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  535. <entry> The drawable.
  536. </entry></row>
  537. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The drawable's type with alpha.
  538. </entry></row>
  539. </tbody></tgroup></informaltable></refsect2>
  540. <refsect2>
  541. <title><anchor id="gimp-drawable-is-rgb">gimp_drawable_is_rgb ()</title>
  542. <programlisting><link linkend="gboolean">gboolean</link>    gimp_drawable_is_rgb            (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  543. <para>
  544. Returns whether the drawable is an RGB type.
  545. </para>
  546. <para>
  547. This procedure returns non-zero if the specified drawable is of type
  548. { RGB, RGBA }.</para>
  549. <para>
  550.  
  551. </para><informaltable pgwide=1 frame="none" role="params">
  552. <tgroup cols="2">
  553. <colspec colwidth="2*">
  554. <colspec colwidth="8*">
  555. <tbody>
  556. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  557. <entry> The drawable.
  558. </entry></row>
  559. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> non-zero if the drawable is an RGB type.
  560. </entry></row>
  561. </tbody></tgroup></informaltable></refsect2>
  562. <refsect2>
  563. <title><anchor id="gimp-drawable-is-gray">gimp_drawable_is_gray ()</title>
  564. <programlisting><link linkend="gboolean">gboolean</link>    gimp_drawable_is_gray           (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  565. <para>
  566. Returns whether the drawable is a grayscale type.
  567. </para>
  568. <para>
  569. This procedure returns non-zero if the specified drawable is of type
  570. { Gray, GrayA }.</para>
  571. <para>
  572.  
  573. </para><informaltable pgwide=1 frame="none" role="params">
  574. <tgroup cols="2">
  575. <colspec colwidth="2*">
  576. <colspec colwidth="8*">
  577. <tbody>
  578. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  579. <entry> The drawable.
  580. </entry></row>
  581. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> non-zero if the drawable is a grayscale type.
  582. </entry></row>
  583. </tbody></tgroup></informaltable></refsect2>
  584. <refsect2>
  585. <title><anchor id="gimp-drawable-is-indexed">gimp_drawable_is_indexed ()</title>
  586. <programlisting><link linkend="gboolean">gboolean</link>    gimp_drawable_is_indexed        (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  587. <para>
  588. Returns whether the drawable is an indexed type.
  589. </para>
  590. <para>
  591. This procedure returns non-zero if the specified drawable is of type
  592. { Indexed, IndexedA }.</para>
  593. <para>
  594.  
  595. </para><informaltable pgwide=1 frame="none" role="params">
  596. <tgroup cols="2">
  597. <colspec colwidth="2*">
  598. <colspec colwidth="8*">
  599. <tbody>
  600. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  601. <entry> The drawable.
  602. </entry></row>
  603. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> non-zero if the drawable is an indexed type.
  604. </entry></row>
  605. </tbody></tgroup></informaltable></refsect2>
  606. <refsect2>
  607. <title><anchor id="gimp-drawable-bytes">gimp_drawable_bytes ()</title>
  608. <programlisting><link linkend="gint">gint</link>        gimp_drawable_bytes             (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  609. <para>
  610. Returns the bytes per pixel.
  611. </para>
  612. <para>
  613. This procedure returns the number of bytes per pixel (or the number
  614. of channels) for the specified drawable.</para>
  615. <para>
  616.  
  617. </para><informaltable pgwide=1 frame="none" role="params">
  618. <tgroup cols="2">
  619. <colspec colwidth="2*">
  620. <colspec colwidth="8*">
  621. <tbody>
  622. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  623. <entry> The drawable.
  624. </entry></row>
  625. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> Bytes per pixel.
  626. </entry></row>
  627. </tbody></tgroup></informaltable></refsect2>
  628. <refsect2>
  629. <title><anchor id="gimp-drawable-width">gimp_drawable_width ()</title>
  630. <programlisting><link linkend="gint">gint</link>        gimp_drawable_width             (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  631. <para>
  632. Returns the width of the drawable.
  633. </para>
  634. <para>
  635. This procedure returns the specified drawable's width in pixels.</para>
  636. <para>
  637.  
  638. </para><informaltable pgwide=1 frame="none" role="params">
  639. <tgroup cols="2">
  640. <colspec colwidth="2*">
  641. <colspec colwidth="8*">
  642. <tbody>
  643. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  644. <entry> The drawable.
  645. </entry></row>
  646. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> Width of drawable.
  647. </entry></row>
  648. </tbody></tgroup></informaltable></refsect2>
  649. <refsect2>
  650. <title><anchor id="gimp-drawable-height">gimp_drawable_height ()</title>
  651. <programlisting><link linkend="gint">gint</link>        gimp_drawable_height            (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  652. <para>
  653. Returns the height of the drawable.
  654. </para>
  655. <para>
  656. This procedure returns the specified drawable's height in pixels.</para>
  657. <para>
  658.  
  659. </para><informaltable pgwide=1 frame="none" role="params">
  660. <tgroup cols="2">
  661. <colspec colwidth="2*">
  662. <colspec colwidth="8*">
  663. <tbody>
  664. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  665. <entry> The drawable.
  666. </entry></row>
  667. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> Height of drawable.
  668. </entry></row>
  669. </tbody></tgroup></informaltable></refsect2>
  670. <refsect2>
  671. <title><anchor id="gimp-drawable-offsets">gimp_drawable_offsets ()</title>
  672. <programlisting><link linkend="gboolean">gboolean</link>    gimp_drawable_offsets           (<link linkend="gint32">gint32</link> drawable_ID,
  673.                                              <link linkend="gint">gint</link> *offset_x,
  674.                                              <link linkend="gint">gint</link> *offset_y);</programlisting>
  675. <para>
  676. Returns the offsets for the drawable.
  677. </para>
  678. <para>
  679. This procedure returns the specified drawable's offsets. This only
  680. makes sense if the drawable is a layer since channels are anchored.
  681. The offsets of a channel will be returned as 0.</para>
  682. <para>
  683.  
  684. </para><informaltable pgwide=1 frame="none" role="params">
  685. <tgroup cols="2">
  686. <colspec colwidth="2*">
  687. <colspec colwidth="8*">
  688. <tbody>
  689. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  690. <entry> The drawable.
  691. </entry></row>
  692. <row><entry align="right"><parameter>offset_x</parameter> :</entry>
  693. <entry> x offset of drawable.
  694. </entry></row>
  695. <row><entry align="right"><parameter>offset_y</parameter> :</entry>
  696. <entry> y offset of drawable.
  697. </entry></row>
  698. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  699. </entry></row>
  700. </tbody></tgroup></informaltable></refsect2>
  701. <refsect2>
  702. <title><anchor id="gimp-drawable-is-layer">gimp_drawable_is_layer ()</title>
  703. <programlisting><link linkend="gboolean">gboolean</link>    gimp_drawable_is_layer          (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  704. <para>
  705. Returns whether the drawable is a layer.
  706. </para>
  707. <para>
  708. This procedure returns non-zero if the specified drawable is a
  709. layer.</para>
  710. <para>
  711.  
  712. </para><informaltable pgwide=1 frame="none" role="params">
  713. <tgroup cols="2">
  714. <colspec colwidth="2*">
  715. <colspec colwidth="8*">
  716. <tbody>
  717. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  718. <entry> The drawable.
  719. </entry></row>
  720. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> Non-zero if the drawable is a layer.
  721. </entry></row>
  722. </tbody></tgroup></informaltable></refsect2>
  723. <refsect2>
  724. <title><anchor id="gimp-drawable-is-layer-mask">gimp_drawable_is_layer_mask ()</title>
  725. <programlisting><link linkend="gboolean">gboolean</link>    gimp_drawable_is_layer_mask     (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  726. <para>
  727. Returns whether the drawable is a layer mask.
  728. </para>
  729. <para>
  730. This procedure returns non-zero if the specified drawable is a layer
  731. mask.</para>
  732. <para>
  733.  
  734. </para><informaltable pgwide=1 frame="none" role="params">
  735. <tgroup cols="2">
  736. <colspec colwidth="2*">
  737. <colspec colwidth="8*">
  738. <tbody>
  739. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  740. <entry> The drawable.
  741. </entry></row>
  742. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> Non-zero if the drawable is a layer mask.
  743. </entry></row>
  744. </tbody></tgroup></informaltable></refsect2>
  745. <refsect2>
  746. <title><anchor id="gimp-drawable-is-channel">gimp_drawable_is_channel ()</title>
  747. <programlisting><link linkend="gboolean">gboolean</link>    gimp_drawable_is_channel        (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  748. <para>
  749. Returns whether the drawable is a channel.
  750. </para>
  751. <para>
  752. This procedure returns non-zero if the specified drawable is a
  753. channel.</para>
  754. <para>
  755.  
  756. </para><informaltable pgwide=1 frame="none" role="params">
  757. <tgroup cols="2">
  758. <colspec colwidth="2*">
  759. <colspec colwidth="8*">
  760. <tbody>
  761. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  762. <entry> The drawable.
  763. </entry></row>
  764. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> Non-zero if the drawable is a channel.
  765. </entry></row>
  766. </tbody></tgroup></informaltable></refsect2>
  767. <refsect2>
  768. <title><anchor id="gimp-drawable-offset">gimp_drawable_offset</title>
  769. <programlisting>#define gimp_drawable_offset    gimp_channel_ops_offset
  770. </programlisting>
  771. <para>
  772.  
  773. </para></refsect2>
  774. <refsect2>
  775. <title><anchor id="gimp-drawable-image-id">gimp_drawable_image_id</title>
  776. <programlisting>#define gimp_drawable_image_id  gimp_drawable_image
  777. </programlisting>
  778. <para>
  779.  
  780. </para></refsect2>
  781. <refsect2>
  782. <title><anchor id="gimp-drawable-bpp">gimp_drawable_bpp</title>
  783. <programlisting>#define gimp_drawable_bpp       gimp_drawable_bytes
  784. </programlisting>
  785. <para>
  786.  
  787. </para></refsect2>
  788.  
  789. </refsect1>
  790.  
  791.  
  792.  
  793.  
  794. </refentry>
  795.